// ------------------------------- 通用定义 start ---------------------------------------
/**
 * @apiDefine RequestHeader
 *
 * @apiHeader  {String} x-sys-token 授权认证字段
 */

/**
 * @apiDefine RequestPagingParam
 *
 * @apiParam {int} page 开始页数【必填】
 * @apiParam {int} size 每页记录条数【必填】
 */

/**
 * @apiDefine RequestError
 *
 * @apiError {int} errcode 错误代码
 * @apiError {String} errmsg 错误信息
 * @apiErrorExample 失败-返回信息:
 *     HTTP/1.1 200 OK
 *     {
 *      "errcode":1000,
 *      "errmsg":"参数错误",
 *     }
 */

/**
 * @apiDefine RequestSuccess
 *
 * @apiSuccess {int} errcode 结果码
 * @apiSuccess {String} errmsg 消息说明
 * @apiSuccess {Object} data 返回数据下面示例为数据结构
 * @apiSuccessExample 成功-返回信息:
 *     HTTP/1.1 200 OK
 *     {
 *      "errcode":0,
 *      "errmsg":"请求成功",
 *      "data": { ... }
 *     }
 */

/**
 * @apiDefine addSuccess
 *
 * @apiSuccess {int} errcode 结果码
 * @apiSuccess {String} errmsg 消息说明
 * @apiSuccess {Object} data 返回数据下面示例为数据结构
 * @apiSuccessExample 成功-返回信息:
 *     HTTP/1.1 200 OK
 *     {
 *      "errcode": 0,
 *      "errmsg":"新增成功",
 *      "data": ""
 *     }
 */

/**
 * @apiDefine updateSuccess
 *
 * @apiSuccess {int} errcode 结果码
 * @apiSuccess {String} errmsg 消息说明
 * @apiSuccess {Object} data 返回数据下面示例为数据结构
 * @apiSuccessExample 成功-返回信息:
 *     HTTP/1.1 200 OK
 *     {
 *      "errcode": 0,
 *      "errmsg":"更新成功",
 *      "data": ""
 *     }
 */

/**
 * @apiDefine deleteSuccess
 *
 * @apiSuccess {int} errcode 结果码
 * @apiSuccess {String} errmsg 消息说明
 * @apiSuccess {Object} data 返回数据下面示例为数据结构
 * @apiSuccessExample 成功-返回信息:
 *     HTTP/1.1 200 OK
 *     {
 *      "errcode": 0,
 *      "errmsg":"删除成功",
 *      "data": ""
 *     }
 */

/**
 * @apiDefine RequestPagingResult
 *
 * @apiSuccess {int} errcode 结果码
 * @apiSuccess {String} errmsg 消息说明
 * @apiSuccess {int} count 记录总数
 * @apiSuccess {Object} data 返回数据下面示例为数据结构
 *
 */
// ------------------------------- 通用定义 end -----------------------------------------
